Skip to content

Conversation

@Beamanator
Copy link
Contributor

Explanation of Change

Creates template for contributors to propose performance improvements in our App product

Fixed Issues

$ #66161

Tests

None needed, this just adds documentation

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

@Beamanator Beamanator self-assigned this Jan 1, 2026
@Beamanator Beamanator requested a review from a team as a code owner January 1, 2026 17:10
@melvin-bot melvin-bot bot requested review from Krishna2323 and removed request for a team January 1, 2026 17:10
@melvin-bot
Copy link

melvin-bot bot commented Jan 1, 2026

@Krishna2323 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

*To ensure proposals are measurable and based on realistic scenarios, you must meet the following criteria:*
- [ ] **Experience:** I have at least **1 merged PR** in the App repository.
- [ ] **Test Environment:** I tested on a high-traffic account (instructions to create this [here](https://github.com/Expensify/App/blob/main/contributingGuides/CONTRIBUTING.md#high-traffic-accounts)).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still deciding if we should go with a high traffic account, OR link to some cleaned onyx state for download

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think having a real online account is better so it is closer to real-life user experience, however, I think we might need a bit more complex account than the high-traffic account. It does not have any transactions/ approvers etc as far as I know. Maybe we could beef it up with some script?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with both things Vit said.

We also want to be careful that this demo account doesn't become outdated as we release more and more functionality. Just something to keep in mind, don't need to solve it right now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love the plan to use a "real online account" instead of purely importing onyx state, and yeah maybe a follow-up to getting this running will be to figure out how to beef up accounts for many-transactions / many-workspace-members / etc?

@Beamanator Beamanator changed the title Add section for Proposing Performance Improvements [HOLD discussion] Add section for Proposing Performance Improvements Jan 1, 2026
@Beamanator Beamanator removed the request for review from Krishna2323 January 1, 2026 17:12
*To ensure proposals are measurable and based on realistic scenarios, you must meet the following criteria:*
- [ ] **Experience:** I have at least **1 merged PR** in the App repository.
- [ ] **Test Environment:** I tested on a high-traffic account (instructions to create this [here](https://github.com/Expensify/App/blob/main/contributingGuides/CONTRIBUTING.md#high-traffic-accounts)).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think having a real online account is better so it is closer to real-life user experience, however, I think we might need a bit more complex account than the high-traffic account. It does not have any transactions/ approvers etc as far as I know. Maybe we could beef it up with some script?

*To ensure proposals are measurable and based on realistic scenarios, you must meet the following criteria:*
- [ ] **Experience:** I have at least **1 merged PR** in the App repository.
- [ ] **Test Environment:** I tested on a high-traffic account (instructions to create this [here](https://github.com/Expensify/App/blob/main/contributingGuides/CONTRIBUTING.md#high-traffic-accounts)).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with both things Vit said.

We also want to be careful that this demo account doesn't become outdated as we release more and more functionality. Just something to keep in mind, don't need to solve it right now.

___
If you haven't already, check out our [Contributing Guidelines](https://github.com/Expensify/App/blob/main/contributingGuides/CONTRIBUTING.md) and email [email protected] to request access to our Slack channel!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and email [email protected] to request access to our Slack channel!

We handle this via a google form now. Easiest to just delete this text cuz it's already in CONTRIBUTING.md . If you want to keep, update to

If you would like to join our #expensify-open-source Slack channel, fill out this form with your email and Upwork profile link. If you haven't been added in 2 weeks, email [email protected].

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooh ok well maybe I can just keep the first part (check out our contributing guidelines) but remove the part about requesting slack channel access? I think it's always a good reminder & good practice to link to our main CONTRIBUTING docs - but we don't have to explain any processes here that are found there, as you said!

@Beamanator Beamanator requested a review from tgolen January 6, 2026 16:52
Comment on lines 408 to 410
| **Render Count** | | | |
| **Execution Time** | | | |
| **Perceived Latency** | | | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe instead of a table we could use some tool and upload a JSON in the comment? Just to make sure that contributors don't choose only "the best numbers".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's totally fair, what tool would you suggest?

Copy link
Contributor

@staszekscp staszekscp Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general in this case I think the current version can stay as it is to not cause much delay, but I think it's worth to consider the options that we may have!

Internally we're using a tool that our colleague @sumo-slonik has built to compare the commit number and render times from the gathered profile traces. I think the contributors could simply add a screenshot from the tool and the profile traces that were used to generate it. It works great for the component performance, although with a single function execution time it might be a bit more tricky 😄

I usually rely on SpeedScope for analyzing web performance traces, but I’m curious whether others have a faster or more reliable way to measure function execution time—for example, across 100 runs—without significantly modifying the code? 😄 cc: @adhorodyski

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few adjustments - but yeah i think we can improve this as we go, for now let's keep it as is with the new format, unless y'all feel strongly for now!

@Beamanator
Copy link
Contributor Author

Alright y'all thanks so much for all the comments for now! How are we feeling about the current version? We can absolutely change it more in the future, but it would be nice to get this out in the real world soon to see what kind of proposals we get!

Co-authored-by: Carlos Martins <[email protected]>
Copy link
Contributor

@fabioh8010 fabioh8010 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for joining the discussions late, was OOO 🙈 The changes look really great so far! I post some small comments however

## 4. Prerequisites & Eligibility
*To ensure proposals are measurable and based on realistic scenarios, you must meet the following criteria:*
- [ ] **Test Environment:** I tested on a high-traffic account (instructions to create this [here](https://github.com/Expensify/App/blob/main/contributingGuides/CONTRIBUTING.md#high-traffic-accounts)).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought we agreed to use a curated onyx state file obtained from the heavy applause account? https://expensify.slack.com/archives/C05LX9D6E07/p1765376829013879

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah in slack we left it there, but in this PR (here) we discussed and thought it would be better to go with a live account

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I think we are going abck and forth there but we also seen that offline, lots of events get hidden the performance offline is not exactly what we get when user is online, so we would like to use account that is online preferably

*Device Used:* (e.g. iPhone 13, Pixel 6, Chrome on M1 Mac) - Note: Don't use CPU throttling for these measurements!
- Device CPU: ___
- Device RAM: ___
*Evidence:* (Attach screenshots of the profiler or logs for both Before and After below this section)*
Copy link
Contributor

@fabioh8010 fabioh8010 Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should these attachments/logs be attached inside the thread of the Slack message? If yes I think we should be clear about it.

For example, "below this section" won't work in Slack like that

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean clear that it should be the thread and not the main post? It looks clear to me that is should be attached

### Instructions for Submission
1. Copy the template below.
2. Fill out the details strictly following the guide.
3. Post it in `#expensify-open-source` with the title `[Performance Proposal] <Component_Name>`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Title should be included as the header of the Slack message content

___
```
## 1. Component and Flow Description
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## 1. Component and Flow Description
[Performance Proposal] <Component_Name>
## 1. Component and Flow Description

Example

*Performance improvements should not change user experience and product design.*
- [ ] This change preserves existing UX (No visual/behavioral changes).
- [ ] This change alters UX (Description: _________________).
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly an stylish suggestion, but I think the template was designed with a format more compatible to GitHub (markdown) rather than Slack, see how it looks like in Slack.

Screenshot 2026-01-16 at 15 06 34 Screenshot 2026-01-16 at 15 06 42

The ## headings don't work for example, maybe we should replace with something else that gives similar highlighting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants